home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / comm / bbs / maxsutils.lha / MaxUtils / AGgen.lha / AGuideGen13a.doc < prev   
Text File  |  1994-09-20  |  8KB  |  201 lines
  1.                          AGuideGen V1.3a   150994
  2.  
  3. THE STORY SO FAR:
  4.  
  5.   Once upon a time, in a far off land, well, Australia actually, there came
  6. into being a BBS program.
  7.   A BBS program like no other, it was FUN to use, it was FREE (V1.52 onwards
  8. anyway), it inspired creativity in others, etc, etc.
  9.  
  10.   Thus there came upon the land MAXsBBS, and the people did rejoice and say
  11. unto one another, "It's got everything!".
  12.  
  13.   All except one small voice from the back of the crowd, somewhere to the
  14. left, just around the corner, "But does it generate filelists in AmigaGuide
  15. format?" the voice asked.
  16.  
  17.   A great hush fell over the crowd, and all heads swivelled to stare at this
  18. small voice that dared to dampen their jubilation.
  19.  
  20.   "WHAT DO YOU WANT FOR NOTHING ??!!", they cried out, reducing the voice to
  21. a small cowering shadow of its former self.
  22.  
  23.   The owner of the small voice, slunk away to his small abode, equipped with
  24. a copy of MAXsBBS and a another filelist generator someone by the name of
  25. Randy Quick, ( ;-)), had pressed into his hands.
  26.  
  27.   Days later he emerged into the world of the living again with the very
  28. first prototype, (V1.0), of an AmigaGuide filelist generator, this he sent
  29. to Sir Randy in the hope that it would stand a master programmer's scrutiny,
  30. but alas, V1.0 did die the horrible BUG death.
  31.  
  32.   Back to the drawing board went the programmer, found that x==y, and there
  33. emerged V1.1, (number two in a long line of V1.1's).
  34.  
  35.  
  36. THE CONTINUING SAGA, (V1.2):
  37.  
  38.   The programmer, though happy with his work to date, was far from satisfied.
  39. He wanted more options, so users could feel that this was a program worth
  40. waiting for.  Options that would give more POWER to the users, and lo he did
  41. disappear from the programming scene for nearly half a year...
  42.  
  43.   HE RETURNS.
  44.  
  45.   After sweeping the cobwebs off the source code, putting out the cat,
  46. locking himself away from his wife, (who threatens to take a large calibre
  47. shooting iron the mighty GOD...AMIGA!), relearning everything he ever
  48. forgot, and discovering how to stop the creation of those never-to-be-
  49. sufficiently-damned icons, (Thanx once again to Sir Randy, the Quick),
  50. he presents.....
  51.  
  52. FANFARE...
  53.  
  54.                         *****************************
  55.                         * AGuideGen V1.2     130994 *
  56.                         *****************************
  57.  
  58.  
  59. Bloody hell, these updates are coming out faster than excretia out of a
  60. horse with diahorea.
  61.  
  62.                         *****************************
  63.                         * AGuideGen V1.3     140994 *
  64.                         *****************************
  65.  
  66.  
  67. PURPOSE:
  68.  
  69. To generate AmigaGuide compatible filelists for MAXsBBS V1.52 - V1.54.
  70.  
  71. If it works with any other versions, half your luck, why haven't you updated.
  72.  
  73.  
  74. USING IT:
  75.  
  76. It's designed so that you run it externally to MAXsBBS, all it needs is
  77. access to MAXsBBS.Config and File.data, for this to work you've got to have
  78. BBS: assigned to wherever MAXsBBS.Config lives.
  79.  
  80. As for options, these will be explained by example:
  81.  
  82. AGuideGen -?                     - Print a list of options.
  83.  
  84. AGuideGen -D7                    - Output filelist to RAM:, all sections, but
  85.                                    only files uploaded in the last 7 days.
  86.  
  87. NOTE: With -D option, there is no space between the -D and the number, as in
  88.       above example.
  89.  
  90. AGuideGen                        - This will generate an AmigaGuide file in
  91.                                    the RAM: directory, of all your files.
  92.  
  93. AGuideGen -O HD3:                - As above, but the output will goto the
  94.                                    HD3: directory.
  95.  
  96. AGuideGen 20 21 23 24 48         - Generate a list to RAM:, EXCLUDING
  97.                                    sections 20, 21, 23, 24, and 48.
  98.  
  99. AGuideGen -O HD3: 21 45          - Output to HD3:, excluding sections 21 and
  100.                                    45.
  101.  
  102. AGuideGen -F Test[.guide]        - Specifies a different output file, in this
  103.                                    case, a file called 'Test.guide' in RAM:.
  104.                                    The default is 'Fileslist.guide'.
  105.  
  106. NOTE: The .guide in the filename is optional, it'll add it if it doesn't
  107.       exist.
  108.  
  109. AGuideGen -S                     - Generates a seperate guide for each
  110.                                    section, plus a master index file.
  111.  
  112. AGuideGen -J                     - Uses the AmigaDOS JOIN command for final
  113.                                    file output, ONLY when generating one
  114.                                    output file, ie. no -S option.
  115.                                    The JOIN command has to exist in the path
  116.                                    C:.
  117.  
  118. NOTE: If you put the -S and -J option on the same command line, after a long,
  119.       drawn out, bloody battle, the -S will win, ie. it will generate SEPERATE
  120.       files.
  121.  
  122. *********************************************************************************
  123. BIG NOTE: The -J option was put in because I wanted faster file combination
  124.           at the end of the program, it is VERY experimental.
  125.           It works on my machine, but I suggest you try it out on yours
  126.           before letting it run mad in a 'daily BBS update script' or
  127.           whatever.
  128.  
  129.           If it crashes your machine, just remove that option and it will
  130.           revert to the painstakingly slow way of combining files.
  131.           (Of course, if you use the -S option, you won't have this problem :)
  132.  
  133.           If anyone knows a fast way to do the same thing, without reliance
  134.           on a external program, please tell/show me, I can translate almost
  135.           any language, (except assembler), given enough years and good PORT.
  136.           (Oh, and forget about FORTRAN, COBOL, APL, BCPL, TRIPOS,....)
  137.           What the hell, send it in C, BASIC, E, PASCAL, ARexx, MODULA II, or
  138.           KLINGON.
  139. *********************************************************************************
  140.  
  141.  
  142. All options should interwork with each other, except for the above mentioned
  143. NOTE.
  144.  
  145.  
  146. BUGS ETC:
  147.  
  148. Guaranteed free from bugs or your money back, but only if you can prove
  149. it won't work on my machine ;-)
  150.  
  151. ----  This program has been tested on a A500 and a A4000/040.  ----
  152.  
  153. BUT, in the likely event that the (un)forseeable should happen, I can be
  154. contacted at the place below.
  155.  
  156.  
  157.                           Dave Clarke
  158.                           MAXsNET: 3:30003/31
  159.  
  160.  
  161. THE FUTURE:
  162.  
  163. V1.4 is just about thought of, the following options might be added:
  164.  
  165. * Be able to specify the description being split onto 2 lines, (much like my
  166.   very early version 1.0 did, the BUG death one :)
  167.  
  168. If you've got any other ideas, within reason, (bearing in mind the amount
  169. of time I can actually spend at a keyboard due to above wife), just send
  170. them into the blackhole known as MAXsNET, I'll get them sooner or later.
  171.  
  172.  
  173. PS. Sorry about the unformatted doc file, but I *HATE* files with TABS and
  174.     multiple spaces to make neat edges.
  175.  
  176.  
  177. HISTORY:
  178.  
  179. V1.0 - The first, died horribly.  See above.
  180.  
  181. V1.1 - It worked, had only the -O option.
  182.  
  183. V1.2 - Added -F, -D, -S, -J, and -? options. Now using Hisoft BASIC 2 for
  184.        better system compatibility, I hope.
  185.  
  186. V1.3 - General code cleanup.
  187.  
  188. V1.3a - Fixed -F option, wouldn't work if at the end of the command line.
  189.  
  190.  
  191. ACKNOWLEDGEMENTS:
  192.  
  193. Many thanx to Randy Quick for any and all source code that he provided.
  194.  
  195. To Anthony Barrett, for what has got to be the *EASIEST* ever, BBS program
  196. to set up and run.
  197.  
  198. To the original designers of the Amiga, whose forsight is still in the future.
  199.  
  200. And of course, to C= for making the Amiga what it is today ;-)
  201.